/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.document;

/**
 * Contains the default values for the key of the standard properties.
 * 
 * <p>Standard properties for formatting are the following :
 * <ul>
 * <li>{@code FORMAT_BOLD}
 * <li>{@code FORMAT_ITALIC}
 * <li>{@code FORMAT_UNDERLINED}
 * <li>{@code FORMAT_STRUCK}
 * <li>{@code FORMAT_MONOSPACED}
 * <li>{@code FORMAT_SUBSCRIPT}
 * <li>{@code FORMAT_SUPERSCRIPT}
 * </ul>
 * 
 * @author		Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * @version		1.0
 * 
 * @see			ElementProperties 
 */
public interface ElementPropertiesDefaultNames {

	/**
	 * Key used for the text content of a document element.
	 */
	public static final String TEXT_BODY = "text_body" ;//$NON-NLS-1$

	/**
	 * Key used for the caption of an image.
	 */
	public static final String CAPTION = TEXT_BODY ;

	/**
	 * Key used for the url (location) of an image.
	 */
	public static final String LOCATION = "location" ;//$NON-NLS-1$

	/**
	 * Key used for the raw bytes of an image.
	 */
	public static final String IMAGE_DATA = "image_bytes" ;//$NON-NLS-1$

	/**
	 * Key used for the text alignment of a document element.
	 */
	public static final String TEXT_ALIGNMENT = "text_alignment" ;//$NON-NLS-1$

	/**
	 * Key used for the title level.
	 */
	public static final String TITLE_LEVEL = "title_level" ;//$NON-NLS-1$

	/**
	 * Key used for the list id.
	 */
	public static final String LIST_ID = "list_id" ;//$NON-NLS-1$

	/**
	 * Key used for the list level.
	 */
	public static final String LIST_LEVEL = "list_level" ;//$NON-NLS-1$

	/**
	 * Key used for the text that appears instead of website's address.
	 */
	public static final String REPLACEMENT_TEXT = "replacement_text" ;//$NON-NLS-1$

	/**
	 * Key used for the name of the used style for the element.
	 */
	public static final String STYLE = "text_style" ;//$NON-NLS-1$

	/**
	 * Key used for the row span property of a cell.
	 */
	public static final String ROW_SPAN = "row_span" ;//$NON-NLS-1$

	/**
	 * Key used for the col span property of a cell.
	 */
	public static final String COL_SPAN = "col_span" ;//$NON-NLS-1$

	/**
	 * Key used for the grid span property of a cell.
	 */
	public static final String GRID_SPAN = "grid_span" ;//$NON-NLS-1$

	/**
	 * Value used for a left alignment.
	 */
	public static final Integer LEFT_ALIGNMENT = new Integer(0) ;

	/**
	 * Value used for a center alignment.
	 */
	public static final Integer CENTER_ALIGNMENT = new Integer(1) ;

	/**
	 * Value used for a right alignment.
	 */
	public static final Integer RIGHT_ALIGNMENT = new Integer(2) ;

	/**
	 * Key used to indicate a bold text.
	 */
	public static final String FORMAT_BOLD = "format_bold" ;//$NON-NLS-1$

	/**
	 * Key used to indicate an italic text.
	 */
	public static final String FORMAT_ITALIC = "format_italic" ;//$NON-NLS-1$

	/**
	 * Key used to indicate an underlined text.
	 */
	public static final String FORMAT_UNDERLINED = "format_underlined" ;//$NON-NLS-1$

	/**
	 * Key used to indicate a struck text.
	 */
	public static final String FORMAT_STRUCK = "format_struck" ;//$NON-NLS-1$

	/**
	 * Key used to indicate a monospace text.
	 */
	public static final String FORMAT_MONOSPACE = "format_monospace" ;//$NON-NLS-1$

	/**
	 * Key used to indicate a subscript text.
	 */
	public static final String FORMAT_SUBSCRIPT = "format_subscript" ;//$NON-NLS-1$

	/**
	 * Key used to indicate a superscript text.
	 */
	public static final String FORMAT_SUPERSCRIPT = "format_superscript" ;//$NON-NLS-1$

	/**
	 * Key used to indicate a mail destination.
	 */
	public static final String MAIL_DESTINATION = "mail_destination" ;//$NON-NLS-1$

	/**
	 * Key used to indicate a link destination.
	 */
	public static final String LINK_DESTINATION = "link_destination" ;//$NON-NLS-1$

}// interface ElementPropertiesDefaultNames